﻿/*
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at 
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *  
 */

using System;
using java = biz.ritter.javapi;

namespace biz.ritter.javapi.lang
{
    /**
     * Represents a sequence of characters that can be incrementally read (copied)
     * into a {@link CharBuffer}.
     */
    public interface Readable {

        /**
         * Reads characters into the specified {@code CharBuffer}. The maximum
         * number of characters read is {@code CharBuffer.remaining()}.
         * 
         * @param cb
         *            the buffer to be filled with characters read.
         * @return the number of characters actually read, or -1 if this
         *         {@code Readable} reaches its end
         * @throws IOException
         *             if an I/O error occurs.
         */
        int read(java.nio.CharBuffer cb); //throws IOException;
    }
}
